mobileControlDo

Type

command

Summary

Execute specific behaviors of native mobile controls created using mobileControlCreate.

Syntax

mobileControlDo <idOrName>, <action> [, <actionParameter> ...]

Description

Use the mobileControlDo command to execute behaviors specific to a particular native mobile control created using mobileControlCreate. An action may require or have a number of optional extra parameters which are defined in the action listing section below.

**action listing: **

Browser Specific Actions

• "advance": Move forward through the history.
• "retreat": Move backward through the history.
• "reload": Reload the current page.
• "stop": Stop loading the current page.
• "load", baseUrl, htmlText: Loads as page consisting of the given

    htmlText with the given baseUrl. Takes the following additional parameters:
  - *baseUrl*
  - \"*htmlText*
- \"execute\", *script*: Evaluates the given JavaScript script in the
context of the current page. Takes the following additional parameter:
  - *script*

Scroller Specific Actions (iOS Only)

• "flashScrollIndicators": Makes the scroll indicators flash momentarily.

Player Specific Actions

• "play": Start playing the content of the player.
• "pause": Pause the content at the current position.
• "stop": Stop playing the content of the player.
• "prepareToPlay" (iOS Only): Make the content ready to play, but don't actually commence playback.
• "begin seeking forward" (iOS Only): Start seeking forward through the content of the player. Note: removed in LiveCode 9.6
• "begin seeking backward" (iOS Only): Start seeking backward through the content of the player. Note: removed in LiveCode 9.6
• "end seeking" (iOS Only): Stop seeking through the content of the player. Note: removed in LiveCode 9.6
• "snapshot" | "snapshot exactly", time, [ maxWidth, maxHeight ] (iOS Only): Take a snapshot of the movie at time milliseconds from the beginning. If the 'exactly' form is specified the frame produced is as close as possible to time, otherwise the nearest keyframe is used. The snapshot is made available as a new image object cloned from the templateImage, with data in the format as specified by the global paintCompression property. Takes the following additional parameters:
  • time: The milliseconds from the beginning.
  • maxWidth (optional): If maxWidth and maxHeight are specified, the snapshot is scaled to fit within a rectangle of that size but preserving the frame's aspect ratio.
  • maxHeight (optional): If maxWidth and maxHeight are specified, the snapshot is scaled to fit within a rectangle of that size but preserving the frame's aspect ratio.

Text Input Specific Actions

• "focus": Focus on the control. On iOS this will also display the keyboard.

Multi-line Text Input Specific Actions

• "focus": Focus on the control. On iOS this will also display the keyboard.

Multi-line Text Input Specific Actions (iOS Only)

• "scrollRangeToVisible" rangeStart, rangeLength: Ensures the given text range is visible in the view by changing the scroll of the field. Takes the following additional parameters:
  • rangeStart: The start index of the text that is to be made visible.
  • rangeLength: The length of the text that is to be made visible.

Parameters

Name	Type	Description
idOrName		The id or name of the control.
action	enum	The name of the action to perform. See Description for complete action listing.
actionParameter		Additional parameter required for the action.

Examples

mobileControlDo "myPlayerControl", "play"

local tScrollerControlID
mobileControlDo tScrollerControlID, "flashScrollIndicators"

local tBrowserControlName
mobileControlDo tBrowserControlName, "execute", "alert('javascript browser test')"

local tFieldControlName
mobileControlDo tFieldControlName, "focus"

// set the focus for a multi-line text field
mobileControlDo "myMultiLineTextInput", "focus"

Related

glossary: evaluate, global

property: paintCompression

command: mobileControlCreate, mobileControlDelete, mobileControlSet

function: mobileControlGet, mobileControlTarget, mobileControls

Compatibility and Support

Introduced

LiveCode 4.6

OS

ios

android

Platforms

mobile